Rename the document element from "guide" to "devbook" #352
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
The "guide" document element is ambiguous with the previously used GuideXML format. Now that DevBook XML has a schema, this confuses Emacs nXML mode (which uses the document element to locate a schema), e.g. when visiting old GuideXML documentation files. Signed-off-by: Ulrich Müller <[email protected]>
For consistency; this was the only element using camelCase. Signed-off-by: Ulrich Müller <[email protected]>
thesamesam
approved these changes
Oct 31, 2024
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
This has bugged me since quite some time, mainly because nXML mode in Emacs (or rather,
rng-loc) locates the schema based on the XML document element. So, when looking at old documentation, it would see<guide>, loaddevbook.rnc, and would end up highlighting supposedly bad syntax.Renaming the document element to
devbookwill avoid these problems, becauseguidecan then be dropped from nXML mode's schema locating, and the vacuous schema will be used for GuideXML documents (which is not a problem when looking at them).While at it, rename
<contentsTree/>to<contents/>because it is the only element whose name is in camelCase. (No strong opinion about the name here,contentsis what is used by Texinfo. So please speak up if you prefertableofcontents(as in LaTeX),toc(as in Mediawiki), or evenchildlist(used in the old RST Devmanual).)Timeline: If there are no objections, I would start with a transitional release of
app-emacs/nxml-gentoo-schemasthat would accept both the oldguideand the newdevbookelement. The Devmanual would be updated some time after stabilisation of that version.